Skip to content

feat(SDFS): Add destructor for SD card to clean up resources#11521

Merged
me-no-dev merged 10 commits intoespressif:masterfrom
JakubAndrysek:sd/add_destructor
Jun 30, 2025
Merged

feat(SDFS): Add destructor for SD card to clean up resources#11521
me-no-dev merged 10 commits intoespressif:masterfrom
JakubAndrysek:sd/add_destructor

Conversation

@JakubAndrysek
Copy link
Copy Markdown
Collaborator

@JakubAndrysek JakubAndrysek commented Jun 26, 2025

Description of Change

This pull request introduces a destructor to the SDFS class in the SD library to ensure proper cleanup when an instance of the class is destroyed. The destructor calls the end() method to release resources.

Tests scenarios

I have tested my Pull Request on Arduino-esp32 core v3.2.0 with Wokwi and on ESP32 S3 with two connected SD cards.
Tests of the whole SD library will be included in the next PR (separated from this one).

  • Found when I was testing multiple SD cards on ESP32 S3 with dynamic memory allocation using unique_ptr.

@JakubAndrysek JakubAndrysek requested a review from a team as a code owner June 26, 2025 14:02
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 26, 2025

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "feat(SDFS): Add destructor to clean up resources":
    • scope/component should be lowercase without whitespace, allowed special characters are _ / . , * - .

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 10 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello JakubAndrysek, we appreciate your contribution to this project!

📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.
🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.
Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 7fabe3b

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 26, 2025 •
edited
Loading

Test Results

 76 files   76 suites   13m 59s ⏱️
 38 tests  38 ✅ 0 💤 0 ❌
241 runs  241 ✅ 0 💤 0 ❌

Results for commit 7fabe3b.

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 26, 2025

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

MemoryFLASH [bytes]FLASH [%]RAM [bytes]RAM [%]
TargetDECINCDECINCDECINCDECINC
ESP32P4000.000.00000.000.00
ESP32S3000.000.00000.000.00
ESP32S2000.000.00000.000.00
ESP32C3000.000.00000.000.00
ESP32C6000.000.00000.000.00
ESP32H2000.000.00000.000.00
ESP32000.000.00000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32P4ESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
libraries/SD/examples/SD_Test--------------
libraries/SD/examples/SD_time--------------

@lucasssvaz lucasssvaz added Status: Pending Merge Pull Request is ready to be merged labels Jun 26, 2025
@me-no-dev me-no-dev merged commit 9a35d94 into espressif:master Jun 30, 2025
64 of 67 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lucasssvaz lucasssvaz lucasssvaz approved these changes

@P-R-O-C-H-Y P-R-O-C-H-Y P-R-O-C-H-Y approved these changes

Assignees

No one assigned

Labels

Status: Pending Merge Pull Request is ready to be merged

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@JakubAndrysek @lucasssvaz @P-R-O-C-H-Y @me-no-dev